api_result Element

Description

starts a results connection.

Namespace

(none)

Diagram

Overview

api_result

starts a results connection.

Sequence

authentication xs:string

Confirmation that the username and password has been accepted.

num_results xs:int

Defines the number of results in this report.

result 0..∞

Details of the requested reporting.

Sequence

type xs:string

There are a number of possible types when requesting a list, however for inbound fax and SMS the type will be "inbound".

job_num xs:string

This is the number that the PRODOCOM production system uses to identify a specific job. This will be an 8 digit alpha numeric field. The job_num can also be used in the PRODOCOM web portal to locate a job in the reporting option.

date_gmt xs:string

The GMT (Greenwich Mean time) date that the message was received.

location xs:string

The location can either be "pending" if not yet complete, "transmit" if finished sending or "received" for an inbound fax or SMS.

recipient xs:string

This will show the inbound fax or SMS number.

seconds xs:string

This will show the number of seconds it took to receive a fax (will not be displayed for an inbound SMS).

pages_sent xs:int

This will show the number of pages received. It should be noted that an inbound SMS page is 160 characters.

count xs:int

The count will always be "1".

failed xs:int

The number of failed receive attempts.

success xs:int

The number of successful receive attempts.

complete xs:int

The number of completed receive attempts.

download xs:string

A document Id that can be used to download a copy of the document received using the download a document request.

Source

<xs:element name="api_result" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:complexType>
    <xs:sequence>
      <xs:element type="xs:string" name="authentication" />
      <xs:element type="xs:int" name="num_results" />
      <xs:element name="result" maxOccurs="unbounded" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element type="xs:string" name="type" />
            <xs:element type="xs:string" name="job_num" />
            <xs:element type="xs:string" name="date_gmt" />
            <xs:element type="xs:string" name="location" />
            <xs:element type="xs:string" name="recipient" />
            <xs:element type="xs:string" name="seconds" />
            <xs:element type="xs:int" name="pages_sent" />
            <xs:element type="xs:int" name="count" />
            <xs:element type="xs:int" name="failed" />
            <xs:element type="xs:int" name="success" />
            <xs:element type="xs:int" name="complete" />
            <xs:element type="xs:string" name="download" />
          </xs:sequence>
        </xs:complexType>
      </xs:element>
    </xs:sequence>
  </xs:complexType>
</xs:element>